sdk/samples/all in on code/Visual Studio 2008/CSTFSCustomWorkItemControl/OpenOtherWorkItemControl.cs

   1 /****************************** Module Header *********************************************************\
   2  * Module Name: OpenOtherWorkItemControl
   3  * Project:     CSTFSCustomWorkItemControl
   4  * Copyright (c) Microsoft Corporation.
   5  *
   6  * The OpenOtherWorkItemControl demonstrates how to create and deploy a Custom WorkItem Control which
   7  * open another work item in Visual Studio.
   8  *
   9  * This source is subject to the Microsoft Public License.
  10  * See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
  11  * All other rights reserved.
  12  *
  13  * THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
  14  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
  16  \********************************************************************************************************/
  17
  18
  19
  20 #region Using Directive
  21 using System;
  22 using System.Collections.Generic;
  23 using System.Linq;
  24 using System.Text;
  25 using System.Windows.Forms;
  26
  27 using Microsoft.TeamFoundation.WorkItemTracking.Controls;
  28 using System.ComponentModel;
  29 using Microsoft.TeamFoundation.WorkItemTracking.Client;
  30 using System.Collections.Specialized;
  31 using Microsoft.VisualStudio.TeamFoundation;
  32 using Microsoft.TeamFoundation.Client;
  33 using Microsoft.VisualStudio.TeamFoundation.WorkItemTracking;
  34 #endregion
  35
  36 namespace CSTFSCustomWorkItemControl
  37 {
  38     public class OpenOtherWorkItemControl : UserControl, IWorkItemControl
  39     {
  40         #region InitializeUIComponent
  41
  42         public OpenOtherWorkItemControl()
  43         {
  44             InitializeComponent();
  45         }
  46
  47         private TextBox tb1;
  48         private Button btn1;
  49
  50         private void InitializeComponent()
  51         {
  52             this.tb1 = new System.Windows.Forms.TextBox();
  53             this.btn1 = new System.Windows.Forms.Button();
  54             this.SuspendLayout();
  55             //
  56             // tb1
  57             //
  58             this.tb1.Location = new System.Drawing.Point(4, 2);
  59             this.tb1.Name = "tb1";
  60             this.tb1.Size = new System.Drawing.Size(100, 20);
  61             this.tb1.TabIndex = 0;
  62             //
  63             // btn1
  64             //
  65             this.btn1.Location = new System.Drawing.Point(111, 0);
  66             this.btn1.Name = "btn1";
  67             this.btn1.Size = new System.Drawing.Size(66, 23);
  68             this.btn1.TabIndex = 1;
  69             this.btn1.Text = "Open";
  70             this.btn1.UseVisualStyleBackColor = true;
  71             this.btn1.Click += new System.EventHandler(this.btn1_Click);
  72             //
  73             // OpenOtherWorkItemControl
  74             //
  75             this.Controls.Add(this.btn1);
  76             this.Controls.Add(this.tb1);
  77             this.Name = "OpenOtherWorkItemControl";
  78             this.Size = new System.Drawing.Size(180, 25);
  79             this.ResumeLayout(false);
  80             this.PerformLayout();
  81
  82         }
  83         #endregion
  84
  85         #region Fields and properties
  86
  87         private EventHandlerList m_events;
  88         private EventHandlerList Events
  89         {
  90             get
  91             {
  92                 if (m_events == null)
  93                 {
  94                     m_events = new EventHandlerList();
  95                 }
  96                 return m_events;
  97             }
  98         }
  99
 100         private static object EventBeforeUpdateDatasource = new object();
 101         private static object EventAfterUpdateDatasource = new object();
 102
 103         private StringDictionary m_properties;
 104         private bool m_readOnly;
 105         private IServiceProvider m_serviceProvider;
 106         private WorkItem m_workItem;
 107         private string m_fieldName;
 108
 109        /// <summary>
 110         ///   The top-level object in the Visual Studio automation object model.
 111        /// </summary>
 112         EnvDTE80.DTE2 dte2;
 113         EnvDTE80.DTE2 DTE2
 114         {
 115             get
 116             {
 117                 if (dte2 == null)
 118                 {
 119                     //Get Visual Studio automation object model from m_serviceProvider
 120                     var vsModel = m_serviceProvider.GetService(typeof(EnvDTE.DTE));
 121                     dte2 = (EnvDTE80.DTE2)vsModel;
 122                 }
 123                 return dte2;
 124             }
 125         }
 126         #endregion
 127
 128         #region IWorkItemControl Members
 129
 130         /// <summary>
 131         /// Raise this events before updating WorkItem object with values. When value is changed
 132         /// by a control, work item form asks all controls (except current control) to refresh their display
 133         /// values (by calling InvalidateDatasource) in case if affects other controls
 134         /// </summary>
 135         public event EventHandler BeforeUpdateDatasource
 136         {
 137             add { Events.AddHandler(EventBeforeUpdateDatasource, value); }
 138             remove { Events.RemoveHandler(EventBeforeUpdateDatasource, value); }
 139         }
 140         /// <summary>
 141         /// Raise this event after updating WorkItem object with values. When value is changed
 142         /// by a control, work item form asks all controls (except current control) to refresh their display
 143         /// values (by calling InvalidateDatasource) in case if affects other controls
 144         /// </summary>
 145         public event EventHandler AfterUpdateDatasource
 146         {
 147             add { Events.AddHandler(EventAfterUpdateDatasource, value); }
 148             remove { Events.RemoveHandler(EventAfterUpdateDatasource, value); }
 149         }
 150
 151         /// <summary>
 152         /// Control is asked to clear its contents
 153         /// </summary>
 154         void IWorkItemControl.Clear()
 155         {
 156             tb1.Text = string.Empty;
 157         }
 158
 159         /// <summary>
 160         /// Control is requested to flush any data to workitem object.
 161         /// </summary>
 162         void IWorkItemControl.FlushToDatasource()
 163         {
 164         }
 165
 166         ///<summary>
 167         /// Asks control to invalidate the contents and redraw.
 168         /// </summary>
 169         void IWorkItemControl.InvalidateDatasource()
 170         {
 171         }
 172
 173         ///<summary>
 174         /// All attributes specified in work item type definition file for this control, including custom attributes
 175         /// </summary>
 176         StringDictionary IWorkItemControl.Properties
 177         {
 178             get
 179             {
 180                 return m_properties;
 181             }
 182             set
 183             {
 184                 m_properties = value;
 185             }
 186         }
 187
 188         /// <summary>
 189         /// Whether the control is readonly.
 190         /// </summary>
 191         bool IWorkItemControl.ReadOnly
 192         {
 193             get
 194             {
 195                 return m_readOnly;
 196             }
 197             set
 198             {
 199                 m_readOnly = value;
 200             }
 201         }
 202
 203         /// <summary>
 204         /// Gives pointer to IServiceProvider if you have to use VS Services.
 205         /// </summary>
 206         void IWorkItemControl.SetSite(IServiceProvider serviceProvider)
 207         {
 208             m_serviceProvider = serviceProvider;
 209         }
 210
 211         /// <summary>
 212         /// WorkItemDatasource refers to current work item object.
 213         /// </summary>
 214         object IWorkItemControl.WorkItemDatasource
 215         {
 216             get
 217             {
 218                 return m_workItem;
 219             }
 220             set
 221             {
 222                 m_workItem = (WorkItem)value;
 223
 224                 //WorkItem.FieldChanged event is very useful, and it will be fired when the value
 225                 //  of other field changed
 226                 //m_workItem.FieldChanged+=new WorkItemFieldChangeEventHandler(m_workItem_FieldChanged);
 227             }
 228         }
 229
 230         /// <summary>
 231         /// The field name which the control is associated with in work item type definition.
 232         ///</summary>
 233         string IWorkItemControl.WorkItemFieldName
 234         {
 235             get
 236             {
 237                 return m_fieldName;
 238             }
 239             set
 240             {
 241                 m_fieldName = value;
 242             }
 243         }
 244         #endregion
 245
 246         #region Private funtions
 247
 248         /// <summary>
 249         /// Returen the instance of TeamFoundationServerExt, from which we can get current
 250         /// TFS ActiveProjectContext
 251         /// </summary>
 252         private TeamFoundationServerExt GetTFSExt()
 253         {
 254             TeamFoundationServerExt tfsExt = DTE2.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt") as TeamFoundationServerExt;
 255             if ((tfsExt.ActiveProjectContext.DomainUri == null) || (tfsExt.ActiveProjectContext.ProjectUri == null))
 256             {
 257                 MessageBox.Show("Error");
 258                 return null;
 259             }
 260             return tfsExt;
 261         }
 262         #endregion
 263
 264         #region UI Event
 265         private void btn1_Click(object sender, EventArgs e)
 266         {
 267             //check whether the value in tb1 is integer
 268             int workitemID = 0;
 269             bool isInteger = int.TryParse(tb1.Text, out workitemID);
 270             if (!isInteger || workitemID <= 0)
 271             {
 272                 MessageBox.Show("Work Item ID must be an integer and lager than 0");
 273                 return;
 274             }
 275
 276
 277
 278             TeamFoundationServerExt tfsExt = this.GetTFSExt();
 279             //chech whether tfsExt exists
 280             if (tfsExt != null)
 281             {
 282                 DocumentService witDocumentService = (DocumentService)DTE2.DTE.GetObject(
 283                     "Microsoft.VisualStudio.TeamFoundation.WorkItemTracking.DocumentService");
 284                 //create a TFS instance with the url
 285                 TeamFoundationServer activeTFS = new TeamFoundationServer(
 286                     tfsExt.ActiveProjectContext.DomainUri);
 287                 IWorkItemDocument widoc = null;
 288                 widoc = witDocumentService.GetWorkItem(activeTFS, workitemID, this);
 289                 try
 290                 {
 291                     //Open the work item in Visual Studio
 292                     witDocumentService.ShowWorkItem(widoc);
 293                 }
 294                 finally
 295                 {
 296                     widoc.Release(this);
 297                 }
 298             }
 299         }
 300         #endregion
 301     }
 302 }